cs-webhook-xapi

(0 reviews)

📘 API Documentation - CS Webhook XAPI

This section provides the meaning of the attributes included in the API.

🗂️ Base Information

API Title: CS Webhook XAPI
Version: 1.0.0
Base URL:
```
https://cs-webhook-xapi-{env}v1.us-e1.cloudhub.io/
```
Replace {env} with:
- dev (Development)
- qa (Quality Assurance)
- prod (Production)

🔑 API KEYS

"Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.
- Type: String
- Length: Minimum 36 characters, maximum 37 characters
- Description: Authentication token required to access the API.
"client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.
- Type: String
- Length: Minimum 32 characters, maximum 36 characters
- Description: Unique client identifier to authenticate the request.

NOTE: These API KEYS are required to make any request to our services.

📧 PayU Web Checkout Confirmation (POST /payu/web-checkout/confirmation)

"transactionId"
- Type: String
- Length: Maximum 50 characters
- Description: Unique identifier for the payment transaction.
"status"
- Type: String
- Allowed Values: APPROVED, DECLINED, PENDING
- Description: Current status of the transaction.

Example Request:

curl -X POST "https://cs-webhook-xapi-prod.v1.us-e1.cloudhub.io/payu/web-checkout/confirmation" \
  -H "Content-Type: application/json" \
  -H "client_id: YOUR_CLIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{ "transactionId": "123456", "status": "APPROVED" }'

🔍 Common Parameters

Parameter	Type	Description	Required
`client_id`	`string`	Unique identifier for API clients	✅
`Authorization`	`string`	Bearer token for secure access	✅
`transactionId`	`string`	Payment transaction ID	✅
`status`	`string`	Payment status	✅

🛡️ Security Schemes

Client ID Enforcement

Field	Type	Required	Length (characters)	RegEx
`client_id`	String	Yes	32 - 36	`[a-zA-Z0-9]`
`client_secret`	String	Yes	32 - 64	`[a-zA-Z0-9]`

OAuth 2.0

Field	Type	Required	Length (characters)	RegEx
`Authorization`	String	Yes	36 - 37	`[a-zA-Z0-9-_.]`

⚠️ Error Codes

Code	Description	Suggested Solution
400	Bad Request	Check request syntax and parameters.
401	Unauthorized	Validate authentication credentials.
404	Not Found	Confirm the endpoint URL.
500	Internal Server Error	Retry or contact technical support.

📞 Support

For assistance, contact the Integration Services and Applications Coordination team.

Email: epalma@fg

Last updated: April 2025